﻿//
// MudTools.OfficeInterop 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
//
// 本项目主要遵循 MIT 许可证和 Apache 许可证（版本 2.0）进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
//
// 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动！任何基于本项目二次开发而产生的一切法律纠纷和责任，我们不承担任何责任！

namespace MudTools.OfficeInterop;
/// <summary>
/// 表示 Office 中选取器对话框的接口封装。
/// 该接口提供对选取器对话框功能的访问。
/// </summary>
public interface IOfficePickerDialog : IDisposable
{
    /// <summary>
    /// 获取或设置选取器对话框的数据处理器 ID。
    /// </summary>
    string DataHandlerId { get; set; }

    /// <summary>
    /// 获取或设置选取器对话框的标题。
    /// </summary>
    string Title { get; set; }

    /// <summary>
    /// 获取选取器对话框的属性集合。
    /// </summary>
    IOfficePickerProperties Properties { get; }

    /// <summary>
    /// 创建属性集合。
    /// </summary>
    /// <returns>新的属性集合对象。</returns>
    IOfficePickerResults CreatePickerResults();

    /// <summary>
    /// 显示选取器对话框。
    /// </summary>
    /// <param name="singleSelect">是否单选模式。</param>
    /// <param name="existingResults">父窗口句柄。</param>
    /// <returns>选取结果集合。</returns>
    IOfficePickerResults Show(bool singleSelect = true, IOfficePickerResults? existingResults = null);

    /// <summary>
    /// 检查是否已创建属性集合。
    /// </summary>
    bool IsPickerPropertiesCreated { get; }
}